Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Migrate Installation instructions to conda-forge #98

Merged
merged 3 commits into from
Aug 21, 2024

Conversation

cbueth
Copy link
Collaborator

@cbueth cbueth commented Aug 20, 2024

As the superblockify conda-forge feedstock now is on the main channel, see conda-forge/superblockify-feedstock@5b9256e, installation instructions need to be updated in the README.md and documentation:

conda create -n sb_env -c conda-forge superblockify

Closes #97

Reviewing Questions:

  • Any other changes in the README.md or installation page (docs/installation.md) needed?
  • Add more info to the website landing page (docs/index.rst)?

image

image

@cbueth cbueth requested a review from mszell August 20, 2024 09:39
@cbueth cbueth self-assigned this Aug 20, 2024
@cbueth cbueth linked an issue Aug 20, 2024 that may be closed by this pull request
@codecov-commenter
Copy link

codecov-commenter commented Aug 20, 2024

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.42%. Comparing base (6e5f9bb) to head (5f53ea7).
Report is 4 commits behind head on main.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #98   +/-   ##
=======================================
  Coverage   94.42%   94.42%           
=======================================
  Files          31       31           
  Lines        1885     1885           
  Branches      448      448           
=======================================
  Hits         1780     1780           
  Misses          4        4           
  Partials      101      101           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mszell
Copy link
Member

mszell commented Aug 21, 2024

Thx! The how to cite part looks very good.
We could add one sentence just below the superblockify_concept.png image: Read more about superblockify here: https://doi.org/10.21105/joss.06798
From my side please merge/push.

@anastassiavybornova
Copy link
Collaborator

Tiny comment, since we're at it, I'd add our github handles to the Credits part (incl yours Calrson).
Rest looks good to me!

@cbueth cbueth force-pushed the 97-update-installation-instructions branch from 8dc4113 to 5f53ea7 Compare August 21, 2024 09:24
@cbueth cbueth merged commit 92e2619 into main Aug 21, 2024
27 checks passed
@cbueth cbueth deleted the 97-update-installation-instructions branch August 21, 2024 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update installation instructions
4 participants